home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 051-075 / disk_066 / tagbbs / tag.doc < prev   
Text File  |  1992-05-06  |  18KB  |  522 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                TAG-BBS 1.02
  11.  
  12.                                Introduction
  13.  
  14.  
  15.  
  16.  
  17.  
  18.          TAG-BBS is an online message and file handling system written
  19.     by Patrick E. Hughes specially  for  the  Amiga personal computer.
  20.     This manual  describes  the  installation  and  operation  of  the
  21.     software.
  22.  
  23.          Speaking  generically,  a  Bulletin  Board  System  (BBS)  is
  24.     nothing more than a program  that  organizes  a series of notes to
  25.     make them easier to read.  Specifically,  TAG-BBS is this and much
  26.     much more. Not only are messages  neatly  organized and maintained
  27.     by TAG-BBS,  but people may send private mail and access files for
  28.     transfer and reading.  In  addition,  each  of  these abilities is
  29.     protected with a flexible security.
  30.  
  31.          This is a Share-Ware program. This  implies that you may make
  32.     As Many Copies As Desired and are  Encouraged To Pass It Around to
  33.     as many people as possible (including electronically..). This also
  34.     implies that I  wrote  it  entirely  in  my  own time and received
  35.     precious little help getting it done. If you use TAG-BBS regularly
  36.     or in a serious (business, profit) fashion I request that you send
  37.     in a contribution to aid further  development   to the program and
  38.     its utilities.
  39.  
  40.  
  41.          Send the suggested $25.00 dollar contribution to:
  42.  
  43.      
  44.                  Sands and Cie. 
  45.              attn: Patrick E. Hughes 
  46.           419 N. Larchmont, Suite #218 
  47.              Los Angeles, CA   90004 
  48.      
  49.  
  50.          Check or money order payable to Patrick E. Hughes 
  51.      
  52.  
  53.  
  54.             For your contribution you get the following:
  55.  
  56.     o    The latest program update
  57.  
  58.     o    A Manual including recent Question & Answer excerpts
  59.     direct from AmigaBoard!, with further commentary
  60.  
  61.     o    Access to the AmigaBoard! "TAG-BBS Sysop" Message Base
  62.     for guaranteed answers to important questions     
  63.  
  64.     o    The satisfaction of knowing that you are helping in the
  65.     development and improvement of TAG-BBS
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.          So much for the hype and explanations,  now comes the list of 
  75.     features available with TAG-BBS. You will find this list handy for 
  76.     comparisons with other software: 
  77.      
  78.  
  79.      
  80.     o    Messages  may be separated  into  an  unlimited  number  of 
  81.          bases, or "sub-boards" as they are usually called. Each has 
  82.          it's own  security,  and each  may be  of a different size.
  83.      
  84.     o    Files are much  the same as messages, the only limitation 
  85.          being  the amount  of disk  space  available. You may use 
  86.          as many subdirectories as you want, and each has it's own 
  87.          security.  At present Xmodem-Checksum and  Xmodem-CRC are 
  88.          supported  protocols,  and  the  software  automatically 
  89.          responds to the caller's settings.
  90.      
  91.     o    Xmodem checksum and CRC automatically "chop" incoming
  92.          files to proper size, there is no sysop maintenance
  93.          required to render files executable as on other systems.
  94.          This means that file sizes reported are also always accurate.
  95.  
  96.     o    Security is flexible and based on the individual account 
  97.          rather than the entire system. 
  98.      
  99.     o    Automatic support for all modems via their result codes. 
  100.          All serial I/O routines have been hand optimised and are 
  101.          fully buffered for top speed, this includes protocol 
  102.          transfers too, where the increases really show! 
  103.      
  104.     o    Sysop is given as much power as is practical. Increase and 
  105.          decrease time limits instantly, edit accounts instantly online,
  106.          force instant logoff, control of I/O streams (serial in/out, 
  107.          screen & keyboard on/off), send all output to printer 
  108.          and disk file. 
  109.      
  110.     o    TAG-BBS was designed with two criterion in mind, speed 
  111.          and reliability. Using efficient programming techniques has 
  112.          resulted in both a system unburdened by unrealistic limits 
  113.          and one ideally suited for a multi-tasking system. The 
  114.          software was written and tested fully on an Amiga system, 
  115.          and verified on a fully expanded hardware setup, not ported
  116.          from some other brand of computer..
  117.      
  118.     o    Multi-tasking is not hampered! You can do whatever you 
  119.          like since TAG runs as a separate process by design, and 
  120.          follows all programming guidelines; I assume memory is 
  121.          available for the other tasks, naturally. 
  122.      
  123.      
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.      
  132.                           Hardware Requirements 
  133.      
  134.     Amiga 1000 Personal Computer: 
  135.          512K RAM recommended
  136.          1 disk drive (2nd drive heavily recommended)
  137.          Modem (must support DTR pin, almost all do..)
  138.                (can use locally without modem for testing)
  139.  
  140.                             Hardware Supported 
  141.      
  142.     All extra memory improves performance and sizes allowed
  143.     All AmigaDOS compatible hard drives of any capacity 
  144.     All printers. Used for online "hard copy" as well as 
  145.          account and system reports (in future) 
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.                          Configuring Your System 
  158.      
  159.          Defining your system  means  filling  in  a set of text files 
  160.     with the required information, nothing  more nothing less. You can 
  161.     use any standard text editor for this purpose: Ed, MicroEmacs, vi; 
  162.     all  come  to  mind.  The  files  involved  in  this  are  called: 
  163.     Tag_System, Tag_Boards, Tag_Bulletins,  and Tag_Libraries. To make 
  164.     things easier for you,  I  also  include  blanks  all  ready to be 
  165.     filled in and  heavily  annotated  examples  to  show you how it's 
  166.     done; these files are  named  exactly  as above, but have ".blank" 
  167.     and ".example" endings. 
  168.      
  169.      
  170.          Tag_System 
  171.     Contains all the pertinent  information  on the system itself, the 
  172.     default securities for  accounts,  modem  control strings, and the 
  173.     very small mail definition. 
  174.      
  175.          Tag_Boards 
  176.     Location, size, and security of the message bases on your system. 
  177.      
  178.          Tag_Bulletins 
  179.     Each bulletin is a text file, which  can be read by anyone who has 
  180.     the appropriate security.  Each  may  be  located anywhere, on any 
  181.     disk as long as it is described here. 
  182.      
  183.          Tag_Libraries 
  184.     As with  the  message  bases,  each  library  defines  a  separate 
  185.     subdirectory. Other than that,  your  only worry is  what security 
  186.     each section deserves to worry about. 
  187.      
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      
  196.                               A WALK-THROUGH 
  197.      
  198.          First you should go through the example files and using their 
  199.     guidelines fill in the blanks to define  a system configuration. I 
  200.     leave the details of this step up to the Tag_xxx.Example files and 
  201.     you. 
  202.      
  203.          After you finish filling out  the  Tag_xxxx  files, copy them 
  204.     into the S: directory of your WorkBench disk. AmigaDOS uses the S: 
  205.     directory for its startup  files,  and  so does TAG-BBS. I do this 
  206.     for two reasons: one being that  no  matter what directory TAG-BBS 
  207.     is run from it can always  find  its  configuration,  the   second 
  208.     being that TAG-BBS can be run  from  anywhere, there is no need to 
  209.     change directories or have a 'root directory' to deal with. 
  210.      
  211.          Next  you  must  create   all   the   directories  that  your 
  212.     configuration requires. The only thing to worry about here is that 
  213.     you get all the names spelled correctly. 
  214.      
  215.          The next to last step in  the  walk-through,  making  all the 
  216.     data files required. Run  the  Generate  utility  and  watch it go 
  217.     through its gyrations. If there will  be any problems running what 
  218.     you wrote into the configuration files Generate will abort and let 
  219.     you know where it couldn't  continue.  Using this information will 
  220.     allow you to rewrite your  configuration  and  try again. If there 
  221.     are any errors that you can't  figure  out  pay close attention to 
  222.     the amount of disk space left. TAG-BBS  creates all the data files 
  223.     needed in their full size;  you  can  never  run out of disk space 
  224.     (file libraries notwithstanding)  with  TAG-BBS, and Generate will 
  225.     not let you use a configuration  too  large for the amount of disk 
  226.     storage available. 
  227.      
  228.          At last, the final step! After all  is written and data files 
  229.     generated "Run TAG-BBS". You'll  see  the windows open, and you'll 
  230.     see it waiting for a caller. By typing in "A" followed by [return] 
  231.     you activate the  account  editor.  Edit  account #1, which is the 
  232.     Sysop by default, and set all  information.  You'll need to make a 
  233.     name, password, and change all security levels to 255. 
  234.  
  235.  
  236.          Voila, vous etes finis.
  237.  
  238.  
  239.  
  240.  
  241.  
  242.                             SECURITY NUMBERS
  243.  
  244.  
  245.         Security is separate for each major section of TAG-BBS, Messages
  246.     Libraries, Bulletins, and Status. I'll discuss each of these in turn
  247.     to make matters clear.
  248.  
  249.         Sec_Status:
  250.     This is the major security you need to know. There are several
  251.     default values, all of which mean very special things.
  252.  
  253.     =    0 Guest. A first time caller, 0 is the suggested value.
  254.  
  255.     =    1 New. Just after Joining the board, 1 is suggested.
  256.  
  257.     =    2 Valid. Set when you edit accounts and Validate.
  258.  
  259.                The above are set from your Tag_System file, and
  260.                represent standard values as defined in the system.
  261.                It is entirely possible for you to give New
  262.                accounts full powers and give everyone
  263.                Sysop status immediately..
  264.  
  265.     >= 100 BoardOp. Can do the message base functions D>elete,
  266.            +>Lock, and ->Unlock to the bases they can visit as
  267.            determined by Sec_Board. A sort of controlled power most
  268.            useful for delegating maintenance.
  269.  
  270.     >= 150 LibOp. Allows the library directory operations R>emove
  271.            on accessible directories. Another semi-powerful maintenance
  272.            delegation feature.
  273.  
  274.     =  255 Sysop. Anyone with 255 Sec_Status can do all sysop functions.
  275.            This includes message base E>xtract, MainMenu E>dit-Accounts,
  276.            and Private Mail $>Read and D>elete. The most powerful online
  277.            capabilities available.
  278.  
  279.         All the other securities are set from 0..255 and are independent of
  280.     status. Therefore a BoardOp can not delete messages from a base which
  281.     is inaccessible because their Sec_Board security won't let them visit.
  282.     One further note, except in the Bulletins, if a section is restricted
  283.     due to security a person will not even SEE it listed.
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.                             FILES ON YOUR DISK 
  292.      
  293.      
  294.     TAG-BBS : The program itself, this is what you run. 
  295.      
  296.     Generate : Utility to generate your system once it is 
  297.                described in the configure files. 
  298.      
  299.     xxx.Help : Example help menus displayed at various times 
  300.                which show available commands and what they do. 
  301.      
  302.     xxx.Text : Files read out for specific events, such as 
  303.                a guest joining the board; these provide information 
  304.                and help customize the look of your board. 
  305.      
  306.     Tag_xxx.Example : Demonstration configure files to help show 
  307.                       a working system, should help you get set up 
  308.      
  309.     Tag_xxx.Blank : Templates to fill in. These are the files you 
  310.                     copy into the S: directory of the WorkBench 
  311.                     disk to get things going. Do not use comments
  312.                     as are shown in the .Example files, they are
  313.                     only there to explain what is represented.
  314.  
  315.     Tag.Stat : Created automatically when you first run the program. 
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.                      CALCULATING SPACE REQUIRED
  323.  
  324.     When running, TAG occupies both disk space and RAM. This dual
  325. nature is the reason for the speed which surpasses all other Amiga
  326. bulletin board programs and some terminal packages as well. Designing
  327. a system that pushes the limits would be trial and error if I were
  328. negligent and didn't tell you how to calculate the space required
  329. without actually generating the data files.
  330.  
  331. Accounts:
  332.     Disk = 386x
  333.      RAM = 0
  334.  
  335. Messages:
  336.     Disk = (136+2500)x
  337.      RAM = 136x + 136
  338.  
  339. Libraries:
  340.     Disk = 216x + File_Sizes (an unknown)
  341.      RAM = 216x + 215
  342.  
  343. Mail:
  344.     Disk = (136+2500)x
  345.      RAM = 136x + 136
  346.  
  347. Bulletins:
  348.     Disk = Text_Sizes (an unknown)
  349.      RAM = 188x
  350.  
  351.     As an example, consider the following small setup-
  352.  
  353. 20 Accounts                    (a very private system)
  354. 1 Message Base @ 20 messages   (full of illiterate people)
  355. 1 Library Directory @ 10 files (who like to download a lot of pictures)
  356. 20 Letters                     (and use mail for text pictures)
  357. 10 Bulletins                   (They need a lot of online help pictures)
  358.  
  359. Accounts:
  360.     Disk = 386 * 20            (7720  bytes)
  361.      RAM = 0                   (0     bytes)
  362. Messages:
  363.     Disk = 2636 * 20           (52720 bytes)
  364.      RAM = (136 * 20) + 136    (2856  bytes)
  365. Libraries:
  366.     Disk = 216 * 10            (2160  bytes)
  367.      RAM = (216 * 10) + 215    (2375  bytes)
  368. Mail:
  369.     Disk = 2636 * 20           (52720 bytes)
  370.      RAM = (136 * 20) + 136    (2856  bytes)
  371. Bulletins:
  372.     Disk = unknown
  373.      RAM = 188 * 10            (1880  bytes)
  374.  
  375. Altogether: 115,310 bytes of disk storage, and 9,949 bytes RAM when running.
  376.  
  377.  
  378.  
  379.  
  380.  
  381.                 COMMANDS AVAILABLE
  382.  
  383. Main Menu:
  384.  
  385.     A>ccount, shows pertinent information (all may use except Guest)
  386.     B>ulletins, text files for reading (governed by Sec_Bulletin)
  387.     C>hat, page sysop to chat (all may use)
  388.     E>dit-Accounts, online editing of users' accounts (255 sysop)
  389.     F>eedback, direct mail to #1 Sysop (all)
  390.     G>oodbye, logoff (all may use)
  391.     I>nfo, system information (all)
  392.     J>oin, become a permanent account, start at New status (only Guest)
  393.     L>ibrary, directories (Sec_Library)
  394.     M>essages, bases (Sec_Board)
  395.     P>rivate-Mail, letters (Sec_Status)
  396.     T>ime, including remaining for user (all)
  397.     ?>Help
  398.  
  399. Bulletins:
  400.  
  401.     #>number, to read (Sec_Bulletin)
  402.     L>ist, shows all files available with +- security
  403.     Q>uit, go to MainMenu
  404.     ?>Help
  405.  
  406. Libraries:
  407.  
  408.     N>ew, visit all directories with new files
  409.     S>elect, answer Y/N to visit or bypass directories
  410.     A>ll, go through all directories
  411.     L>ist, show directories available
  412.     Q>uit, MainMenu
  413.  
  414.     Prompt:
  415.  
  416.         C>atalog, show all files numbered sequentially/non-stop
  417.         D>ownload
  418.         L>ist, one by one
  419.         Q>uit, to Libraries above, or next in sequence
  420.         R>emove, delete (Sec_Status >= 150)
  421.         U>pload
  422.  
  423.         Between (during List)
  424.  
  425.             D>ownload
  426.             Q>uit, to Prompt above
  427.             R>emove, (Sec_Status >=150)
  428.             S>tatistics, size and transfer time
  429.  
  430. Messages:
  431.  
  432.     N>ew, visit all bases with new messages
  433.     S>elect, answer Y/N to visit or bypass bases individually
  434.     A>ll, go through all bases
  435.     L>ist, show bases available
  436.     Q>uit, MainMenu
  437.  
  438.     Prompt:
  439.  
  440.         D>elete, (Sec_Status >=100)
  441.         I>ndividual, select single numbers
  442.         N>ew, read new messages since last logoff
  443.         Q>uit, to Messages above
  444.         R>ead, select numbered range
  445.         W>rite, edit a message
  446.  
  447.         Between (during reading)
  448.  
  449.             A>gain, go back and read it again
  450.             D>elete, (Sec_Status >=100)
  451.             E>xtract, save into a separate text file (Sec_Status ==255)
  452.             L>ast, go backwards by one and read that message
  453.             N>ext, continue the reading
  454.             P>rivate-Reply, send a letter to the author
  455.             Q>uit, to Prompt above
  456.             R>eply-Regular, write a message in response
  457.             +>Lock, protect from RollOver (Sec_Status >=100)
  458.             ->Unlock, allow to RollOver (Sec_Status >=100)
  459.  
  460. During Chat:
  461.  
  462.     Ctrl-V> Version number
  463.     Ctrl-E Ctrl-E> Edit Online User, must be pressed in quick succession
  464.  
  465. Awaiting Logon:
  466.  
  467.     A> Account editor
  468.     $> Sysop immediate logon
  469.     'space'> Local normal logon
  470.     0> Exit to CLI
  471.     ?> Show Options
  472.  
  473.  
  474.  
  475.  
  476.  
  477.                         FUNCTION KEYS
  478.  
  479.  
  480. F1 = Chat On/Off. Only the local keyboard can enter or leave Chat
  481.  
  482. F2 = Time+10min. Increase temporarily the user's time limit online
  483.  
  484. F3 = Time-10min. Remove 10 minutes temporarily from the user
  485.  
  486. F4 = Force Instant Logoff. Immediately jumps to logoff
  487.  
  488. TAG allows you to control all the I/O streams, which can be a very
  489. useful power. There are input and output options, and all choices
  490. will be displayed in the Status Pane
  491.  
  492. F5 = Keyboard Input on/off. In case you don't want any accidental
  493.      key-presses to affect the online user.
  494.  
  495. F6 = Serial Input on/off. This is the most powerful function, since
  496.      you can instantly make the online user unable to enter input!
  497.      Especially handy for taking them for a walk around the system,
  498.      or in Chat when you want to speak uninterrupted.
  499.  
  500. F7 = File Output on/off. Automatically opens and adds to the end
  501.      of a file called TRANSCRIPT.TEXT which is kept in the directory
  502.      indicated by your configure file, Tag_System LOCAT entry.
  503.      All output will be mirrored into this file until turned off.
  504.  
  505. F8 = Printer Output on/off. Make instant hard-copy through the
  506.      printer, mirrors all output until turned off. Useful for
  507.      recording information during Chat, or for keeping a log of
  508.      some action.
  509.  
  510. F9 = Screen Output on/off. If you don't need to see what's going
  511.      on with the system, you can turn this off. It will freeze
  512.      the local screen, but the Status Pane will continue to monitor
  513.      system activity. Will moderately speed up serial output
  514.      since it doesn't stop to send to the local screen.
  515.  
  516. F10= Serial Output on/off. If you don't want an online user to see
  517.      what you're up to, perhaps editing the account during Chat,
  518.      this is the best. Will not send any output to serial until
  519.      turned on again.
  520.  
  521.  
  522.